RMS Config API
Test Cases
Services and Resets
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
| 1 | Get API version/Test API connectivity | Submit a GET API Version | The API will return the API version |
| 2 | Get list of Remote Management Service details associated with a Product ID | Submit a GET Services for a RGW Product | The API will return a 200 response code and product details |
| 3 | Get list of Remote Management Service details associated with a Product ID | Submit a GET Services for a non RGW Product | The API will return a 400 response code and an error response. This is an unsupported product type |
| 4 | Get list of Remote Management Service details associated with a Product ID | Submit a GET Services for a not authorized RGW Product | The API will return a 401 response code and an error response. |
| 5 | Reboot Device | Post a reboot request for an online device | The API will return a 202 response code |
| 6 | Reboot Device | Post a reboot request for an offline device | The API will return a 500 response code and a response code mentioning device is offline |
| 7 | Factory Reset Device | Post a Factory Reset request for an online device | The API will return a 202 response code |
| 8 | Factory Reset Device | Post a Factory Reset request for an offline device | The API will return a 500 response code and a response code mentioning device is offline |
| 9 | Reset Voice Profile | Post a Voice Profile Reset request for an online device | The API will return a 202 response code |
| 10 | Reset Voice Profile | Post a Voice Profile Reset request for an offline device | The API will return a 500 response code and a response code mentioning device is offline |
| 11 | Reset Voice Port | Post a Voice Port Reset request for an online device | The API will return a 202 response code |
| 12 | Reset Voice Port | Post a Voice Port Reset request for an offline device | The API will return a 500 response code and a response code mentioning device is offline |
| 13 | Reset a WiFi port | Post a WiFi Port Reset request for an online device | The API will return a 202 response code |
| 14 | Reset a WiFi port | Post a WiFi Port Reset request for an offline device | The API will return a 500 response code and a response code mentioning device is offline |
| 15 | Put LAN Ethernet port configuration | Post a LAN Port Reset request for an online device | The API will return a 202 response code |
| 16 | Reset LAN Ethernet port | Post a LAN Port Reset request for an offline device | The API will return a 500 response code and a response code mentioning device is offline |
WiFi
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
| 1 | Get WiFi ports configuration, port statistics, devices, and /or device statistics information | Submit a GET WiFi for an online device | The API will return a 200 response code and WiFi details for 2 ports from the device |
| 2 | Get WiFi ports configuration, port statistics, devices, and /or device statistics information | Submit a GET WiFi for an offline device | The API will return a 200 response code and WiFi details for 2 from the configuration cache |
| 3 | Get WiFi ports configuration, port statistics, devices, and /or device statistics information | Submit a GET WiFi with portStatistics enabled for an online device | The API will return a 200 response code and WiFi details for 2 and corresponding statistics from the device |
| 4 | Get WiFi ports configuration, port statistics, devices, and /or device statistics information | Submit a GET WiFi with portStatistics enabled for an offline device | The API will return a 200 response code and WiFi details for 2 from the configuration cache with empty statistics objects |
| 5 | Get WiFi ports configuration, port statistics, devices, and /or device statistics information | Submit a GET WiFi with devices enabled for an online device | The API will return a 200 response code and WiFi details for 2 and the corresponding device lists |
| 6 | Get WiFi ports configuration, port statistics, devices, and /or device statistics information | Submit a GET WiFi with devices enabled for an offline device | The API will return a 200 response code and WiFi details for 2 from the configuration cache with empty devices objects |
| 7 | Get WiFi ports configuration, port statistics, devices, and /or device statistics information | Submit a GET WiFi with devices and device statistics enabled for an online device | The API will return a 200 response code and WiFi details for 2 and the corresponding device lists and device statistics |
| 8 | Get WiFi ports configuration, port statistics, devices, and /or device statistics information | Submit a GET WiFi with devices and device statistics enabled for an offline device | The API will return a 200 response code and WiFi details for 2 from the configuration cache with empty devices objects |
| 9 | Set WiFi port configuration | Submit a WiFi Configuration change to an online device | The API will return a 200 response code and updated WiFi details. A later Get WiFi will indicate that the setStatus field is SET_APPLIED after the configuration has been applied to the device |
| 10 | Set WiFi port configuration | Submit a WiFi Configuration change to an offline device | The API will return a 200 response code and updated WiFi details. A later Get WiFi will indicate that the setStatus field is SET as the configuration is pending |
Voice
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
| 1 | Get voice profiles and/or ports configuration, and/or port statistics information | Submit a GET Voice with profile and ports enabled, for an online device | The API will return a 200 response code and Voice Profile and Ports details from the device. Hyperfibre devices will have 2 voice ports 3rd GEN devices will have 1 voice port |
| 2 | Get voice profiles and/or ports configuration, and/or port statistics information | Submit a GET Voice with profile and ports enabled, for an offline device | The API will return a 200 response code and Voice Profile and Ports details from the configuration cache. Hyperfibre devices will have 2 voice ports 3rd GEN devices will have 1 voice port |
| 3 | Get voice profiles and/or ports configuration, and/or port statistics information | Submit a GET Voice with profile, ports and port statistics enabled, for an online device | The API will return a 200 response code and Voice Profile and Ports details plus port statistics from the device. Hyperfibre devices will have 2 voice ports 3rd GEN devices will have 1 voice port |
| 4 | Get voice profiles and/or ports configuration, and/or port statistics information | Submit a GET Voice with profile, ports and port statistics enabled, for an offline device | The API will return a 200 response code and Voice Profile and Ports details from the configuration cache plus empty port statistics objects Hyperfibre devices will have 2 voice ports 3rd GEN devices will have 1 voice port |
| 5 | Set voice profile configuration | Submit a Voice Profile Configuration change to an online device | The API will return a 200 response code and updated Voice Profile details. A later Get Voice will indicate that the setStatus field is SET_APPLIED after the configuration has been applied to the device |
| 6 | Set voice profile configuration | Submit a Voice Profile Configuration change to an offline device | The API will return a 200 response code and updated Voice Profile details. A later Get WiFi will indicate that the setStatus field is SET as the configuration is pending |
| 7 | Set voice port configuration | Submit a Voice Port Configuration change to an online device | The API will return a 200 response code and updated Voice Port details. A later Get Voice will indicate that the setStatus field is SET_APPLIED after the configuration has been applied to the device |
| 8 | Set voice port configuration | Submit a Voice Port Configuration change to an offline device | The API will return a 200 response code and updated Voice Port details. A later Get Voice will indicate that the setStatus field is SET as the configuration is pending |
WAN
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
| 1 | Get WAN configuration and/or statistics | Submit a GET WAN, for an online 3rd GEN device | The API will return a 200 response code and WAN IPv4 details from the device |
| 2 | Get WAN configuration and/or statistics | Submit a GET WAN, for an offline 3rd GEN device | The API will return a 200 response code and WAN IPv4 details from the configuration cache. |
| 3 | Get WAN configuration and/or statistics | Submit a GET WAN, for an online HyperFibre device | The API will return a 200 response code and WAN IPv4 and IPv6 details from the device. |
| 4 | Get WAN configuration and/or statistics | Submit a GET WAN, for an offline HyperFibre device | The API will return a 200 response code and WAN IPv4 and IPv6 details from the configuration cache. |
| 5 | Get WAN configuration and/or statistics | Submit a GET WAN with Port Statistics enabled for an online device | The API will return a 200 response code and WAN details from the device with the port statistics. |
| 6 | Get WAN configuration and/or statistics | Submit a GET WAN with Port Statistics enabled for an offline device | The API will return a 200 response code and WAN details from the configuration cache with an empty port statistics object. |
| 7 | Set WAN configuration | Submit a WAN Configuration change to an online device | The API will return a 200 response code and updated WAN details. A later WAN will indicate that the setStatus field is SET_APPLIED after the configuration has been applied to the device |
| 8 | Set WAN configuration | Submit a WAN Configuration change to an offline device | The API will return a 200 response code and updated WAN details. A later WAN will indicate that the setStatus field is SET as the configuration is pending |
| 9 | Set WAN configuration | Submit a WAN Configuration with IPv6 to a 3rd GEN device | The API will return a 500 response code and an error code. IPv6 is not supported on 3rd GEN devices |
LAN
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
| 1 | Get LAN Ethernet ports configuration and/or Ethernet ports statistics | Submit a GET Ethernet Ports, for an online device | The API will return a 200 response code and Ethernet Ports details from the device. |
| 2 | Get LAN Ethernet ports configuration and/or Ethernet ports statistics | Submit a GET Ethernet Ports, for an online device | The API will return a 200 response code and Ethernet Ports details from the configuration cache. |
| 3 | Get LAN Ethernet ports configuration and/or Ethernet ports statistics | Submit a GET Ethernet Ports with Port Statistics enabled, for an online device | The API will return a 200 response code and Ethernet Ports details and port statistics from the device. |
| 4 | Get LAN Ethernet ports configuration and/or Ethernet ports statistics | Submit a GET Ethernet Ports with Port Statistics enabled, for an online device | The API will return a 200 response code and Ethernet Ports details from the configuration cache with empty port statistics objects. |
| 5 | Get LAN DHCP & IP configuration | Submit a GET DHCP IP, for an online device | The API will return a 200 response code and DHCP and IP details from the device. |
| 6 | Get LAN DHCP & IP configuration | Submit a GET DHCP IP, for an offline device | The API will return a 200 response code and DHCP and IP details from the configuration cache. |
| 7 | Get LAN Static IP Address configuration | Submit a GET Static Ips, for an online device | The API will return a 200 response code and Static IP details from the device. |
| 8 | Get LAN Static IP Address configuration | Submit a GET Static Ips, for an offline device | The API will return a 200 response code and Static IP details from the configuration cache. |
| 9 | Get LAN hosts information | Submit a GET LAN Hosts, for an online device | The API will return a 200 response code and LAN and WiFi hosts details from the device. |
| 10 | Get LAN hosts information | Submit a GET LAN Hosts, for an offline device | The API will return a 200 response code and an empty hosts object |
| 11 | Put LAN Ethernet port configuration | Submit an Ethernet Port Configuration change to an online device | The API will return a 200 response code and updated Ethernet Port details. A later Get Ethernet Port will indicate that the setStatus field is SET_APPLIED after the configuration has been applied to the device |
| 12 | Put LAN Ethernet port configuration | Submit an Ethernet Port Configuration change to an offline device | The API will return a 200 response code and updated Ethernet Port details. A later Get Ethernet Port will indicate that the setStatus field is SET as the configuration is pending |
| 13 | Set LAN DHCP & IP configuration | Submit an DHCP or IP Configuration change to an online device | The API will return a 200 response code and updated DHCP and IP details. A later Get DhcpIp will indicate that the setStatus field is SET_APPLIED after the configuration has been applied to the device |
| 14 | Set LAN DHCP & IP configuration | Submit an DHCP or IP Configuration change to an online device | The API will return a 200 response code and updated DHCP and IP details. A later Get DhcpIp will indicate that the setStatus field is SET as the configuration is pending |
| 15 | Set LAN Static IP Address configuration | Submit an Static IP Configuration change to an online device | The API will return a 200 response code and updated Static IP details. A later Get Static Ip will indicate that the setStatus field is SET_APPLIED after the configuration has been applied to the device |
| 16 | Set LAN Static IP Address configuration | Submit an Static IP Configuration change to an offline device | The API will return a 200 response code and updated Static IP details. A later Get Static Ip will indicate that the setStatus field is SET as the configuration is pending |
Security
| Test Case | API Endpoint | Suggested Test Case | Expected Result |
| 1 | Get firewall configuration | Submit a GET Firewall, for an online device | The API will return a 200 response code and Firewall details from the device. |
| 2 | Get firewall configuration | Submit a GET Firewall, for an offline device | The API will return a 200 response code and Firewall details from the configuration cache. |
| 3 | Get Port Forwarding | Submit a GET Port Forwarding, for an online device | The API will return a 200 response code and Port Forwarding details from the device. |
| 4 | Get Port Forwarding | Submit a GET Port Forwarding, for an offline device | The API will return a 200 response code and Port Forwarding details from the configuration cache. |
| 5 | Set firewall configuration | Submit a Firewall configuration change to an online device | The API will return a 200 response code and updated Firewall details. A later Get Firewall will indicate that the setStatus field is SET_APPLIED after the configuration has been applied to the device |
| 6 | Set firewall configuration | Submit a Firewall configuration change to an offline device | The API will return a 200 response code and updated Firewall details. A later Get Firewall will indicate that the setStatus field is SET as the configuration is pending |
| 7 | Set port forwarding rules | Submit a Port Forwarding configuration change to an online device | The API will return a 200 response code and updated Port Forwarding details. A later Get Port Forwarding will indicate that the setStatus field is SET_APPLIED after the configuration has been applied to the device |
| 8 | Set port forwarding rules | Submit a Port Forwarding configuration change to an offline device | The API will return a 200 response code and updated Port Forwarding details. A later Get Port Forwarding will indicate that the setStatus field is SET as the configuration is pending |
| 9 | Set ONT admin credentials (Set Username and/or password) | Submit a Credential change | The API will return a 200 response code and updated Credential details. |